| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

FilmGrainEffect.h
1 // FilmGrainEffect.h
3 //
5
6 namespace nkAstraeus
7 {
16 class FilmGrainEffect final : public Effect
17 {
18 public :
19
26 FilmGrainEffect (System* system) noexcept ;
31 virtual ~FilmGrainEffect () ;
32
33 // Getters
37 nkGraphics::Texture* getSourceTexture () const ;
41 float getStrength () const ;
45 bool getRgbNoise () const ;
49 bool getBlendGrainInTarget () const ;
50
51 // Setters
61 void setSourceTexture (nkGraphics::Texture* value) ;
70 void setStrength (float value) ;
81 void setRgbNoise (bool value) ;
93 void setBlendGrainInTarget (bool value) ;
94
95 // Load
96 virtual bool load () override ;
97 virtual void unload () override ;
98
99 public :
100
101 // Statics
112 static nkMemory::UniquePtr<FilmGrainEffect> create (System* system = nullptr) ;
113 } ;
114 }
nkAstraeus::FilmGrainEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkAstraeus::FilmGrainEffect::getRgbNoise
bool getRgbNoise() const
nkAstraeus::FilmGrainEffect::getStrength
float getStrength() const
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:12
nkAstraeus::FilmGrainEffect::getBlendGrainInTarget
bool getBlendGrainInTarget() const
nkAstraeus::FilmGrainEffect::FilmGrainEffect
FilmGrainEffect(System *system) noexcept
nkAstraeus::System
The main entry point for nkAstraeus engine.
Definition: System.h:15
nkAstraeus::FilmGrainEffect::setStrength
void setStrength(float value)
nkAstraeus::FilmGrainEffect::setBlendGrainInTarget
void setBlendGrainInTarget(bool value)
nkAstraeus::FilmGrainEffect
A film grain effect.
Definition: FilmGrainEffect.h:17
nkAstraeus::FilmGrainEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: BlurComplexEffect.h:7
nkMemory::UniquePtr
Smart pointer owning the object instance it encapsulates.
Definition: UniquePtr.h:17
nkAstraeus::Effect
Base class for all effects in the component.
Definition: Effect.h:16
nkAstraeus::FilmGrainEffect::setRgbNoise
void setRgbNoise(bool value)
nkAstraeus::FilmGrainEffect::load
virtual bool load() override
nkAstraeus::FilmGrainEffect::unload
virtual void unload() override
nkAstraeus::FilmGrainEffect::create
static nkMemory::UniquePtr< FilmGrainEffect > create(System *system=nullptr)
nkAstraeus::FilmGrainEffect::~FilmGrainEffect
virtual ~FilmGrainEffect()